Required Software
Java Development Kit (JDK) 21
The backend requires Java 21 (LTS) as specified in the project’spom.xml.
Download: Eclipse Temurin JDK 21
Verify installation:
Java 21 is a Long-Term Support (LTS) release recommended for production use. The project uses Spring Boot 3.4.0, which requires Java 17 or higher.
Node.js 18 or Higher
The frontend is built with React 19 and Vite 7, requiring Node.js 18.0 or higher. Download: Node.js Official Website Verify installation:MySQL Server 8.0+
The application uses MySQL 8.0 or higher for data persistence. Download: MySQL Community Server Verify installation:Make sure the MySQL service is running before proceeding with the installation. The application will connect to
localhost:3306 by default.Git (Optional)
Required only if you’re cloning the repository from version control. Download: Git Official Website Verify installation:Additional Tools (Optional)
Maven
The project includes a Maven Wrapper (mvnw), so you don’t need to install Maven separately. However, if you prefer using a global Maven installation:
Download: Apache Maven
Verify installation:
IDE Recommendations
For Backend (Java):- IntelliJ IDEA (Recommended)
- Eclipse
- VS Code with Java extensions
If using IntelliJ IDEA or Eclipse, make sure to install the Lombok plugin to avoid compilation errors. The project uses Lombok for reducing boilerplate code.
System Requirements
Minimum Hardware
| Component | Requirement |
|---|---|
| CPU | Dual-core processor (2.0 GHz or higher) |
| RAM | 4 GB (8 GB recommended) |
| Disk Space | 2 GB free space |
| OS | Windows 10+, macOS 10.15+, or Linux (Ubuntu 20.04+) |
Port Requirements
Ensure the following ports are available on your system:| Service | Port | Purpose |
|---|---|---|
| Backend API | 8080 | Spring Boot application server |
| Frontend Dev Server | 5173 | Vite development server |
| MySQL Database | 3306 | MySQL database connection |